Correct documentation and update mctp tool help#164
Open
SafetyInObscurity wants to merge 2 commits into
Open
Conversation
mkj
reviewed
Jul 14, 2026
SafetyInObscurity
force-pushed
the
md-fixes
branch
from
0fd9767 to
e259ee6
Compare
Remove duplicate MCTP interface description from the MCTP BusOwner interface description and correct network objects path in docs/mctpd.md. Signed-off-by: James Lee <james@codeconstruct.com.au>
SafetyInObscurity
force-pushed
the
md-fixes
branch
from
e259ee6 to
c3be5ba
Compare
Member
|
Patches look good! 1/2 makes sense, and the consistency in 2/2 is definitely an improvement. One thing we may need to decide on though: vs.
|
The help information for the mctp tool alternated between using <dev> and <IFNAME> when describing interface names. Switch to use <ifname>, which should be more helpful than `dev <dev>` and matches the case conventions of the other options. Update README.md to reflect the changes and add `mctp monitor` to the end, which had been ommitted. Signed-off-by: James Lee <james@codeconstruct.com.au>
SafetyInObscurity
force-pushed
the
md-fixes
branch
from
c3be5ba to
970714c
Compare
Author
|
I think it's better to use |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There are some minor errors, inconsistencies, and duplications in the documentation and
mctptool help. I've aimed to make common-sense corrections.